Skip to content

chore: cleanup outdated services and old links #2108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

lidel
Copy link
Member

@lidel lidel commented Aug 12, 2025

This PR includes some automated cleanup of outdated tutorials that were about web3.storage.


Updated pinning service documentation:

  • Removed outdated web3.storage references from quickstart guides
  • Added current pinning services: Storacha, Pinata, and Filebase
  • Split /quickstart/publish.md and /quickstart/publish_cli.md into distinct GUI-focused and CLI-focused guides
  • Removed unused web3.storage screenshots

Fixed outdated references:

  • Updated Accelerated DHT Client links from experimental features to current config documentation
  • Removed unnecessary "go-ipfs" references (now just "Kubo")

Improved main install page:

  • Added "Publish files with a pinning service" section for easy onboarding

Files modified

  • docs/quickstart/publish.md - Focus on web/GUI interfaces
  • docs/quickstart/publish_cli.md - Focus on CLI/API methods
  • docs/install/README.md - Added pinning section, minor fixes
  • docs/how-to/gateway-best-practices.md - Updated DHT client link
  • docs/how-to/troubleshooting.md - Updated DHT client link

Files removed

  • docs/quickstart/images/ - Removed 6 unused web3.storage screenshots

Checklist before requesting a review

  • Passing the beta version of the Check Markdown links for modified files check. Action results can be viewed here.

Checklist before merging

  • Passing all required checks (The beta Check Markdown links for modified files check is not required)

Updated pinning service documentation:
- Removed outdated web3.storage references from quickstart guides
- Added current pinning services: Storacha, Pinata, and Filebase
- Split /quickstart/publish.md and /quickstart/publish_cli.md into distinct GUI-focused and CLI-focused guides
- Removed unused web3.storage screenshots

Fixed outdated references:
- Updated Accelerated DHT Client links from experimental features to current config documentation
- Removed unnecessary "go-ipfs" references (now just "Kubo")

Improved main install page:
- Added "Publish files with a pinning service" section for easy onboarding

Files modified
- docs/quickstart/publish.md - Focus on web/GUI interfaces
- docs/quickstart/publish_cli.md - Focus on CLI/API methods
- docs/install/README.md - Added pinning section, minor fixes
- docs/how-to/gateway-best-practices.md - Updated DHT client link
- docs/how-to/troubleshooting.md - Updated DHT client link
- docs/install/command-line.md - Removed "(go-ipfs)" reference
- docs/reference/go/api.md - Cleaned up Kubo reference

Files removed
- docs/quickstart/images/ - Removed 6 unused web3.storage screenshots
@lidel lidel requested a review from 2color August 12, 2025 01:40
Copy link
Contributor

github-actions bot commented Aug 12, 2025

🚀 Build Preview on IPFS ready

@2color
Copy link
Member

2color commented Aug 12, 2025

If we're bringing back the publish and publish cli pages, we should add it back to the sidebar menu.

Copy link
Member

@2color 2color left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. LGTM overall. I left a few small comments.

@lidel
Copy link
Member Author

lidel commented Aug 14, 2025

@2color mind taking a final look? added to side menu, renamed them from "publish" to "pinning" and added cross-references with glossary and existing self-hosting tutorials for GUI and CLI.

@lidel lidel marked this pull request as ready for review August 14, 2025 01:40
@@ -105,7 +105,9 @@ module.exports = {
sidebarDepth: 1,
collapsable: false,
children: [
['/quickstart/retrieve','Retrieve with IPFS'],
['/quickstart/retrieve','Retrieve from IPFS'],
['/quickstart/pin','Pin with Browser'],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
['/quickstart/pin','Pin with Browser'],
['/quickstart/pin','Pin (Browser)'],

['/quickstart/retrieve','Retrieve with IPFS'],
['/quickstart/retrieve','Retrieve from IPFS'],
['/quickstart/pin','Pin with Browser'],
['/quickstart/pin-cli','Pin with Command Line'],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
['/quickstart/pin-cli','Pin with Command Line'],
['/quickstart/pin-cli','Pin (CLI)'],

@@ -123,7 +125,9 @@ module.exports = {
sidebarDepth: 1,
collapsable: false,
children: [
['/quickstart/retrieve','Retrieve with IPFS'],
['/quickstart/retrieve','Retrieve from IPFS'],
['/quickstart/pin','Pin with Browser'],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
['/quickstart/pin','Pin with Browser'],
['/quickstart/pin','Pin (Browser)'],

['/quickstart/retrieve','Retrieve with IPFS'],
['/quickstart/retrieve','Retrieve from IPFS'],
['/quickstart/pin','Pin with Browser'],
['/quickstart/pin-cli','Pin with Command Line'],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
['/quickstart/pin-cli','Pin with Command Line'],
['/quickstart/pin-cli','Pin (CLI)'],

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants